home *** CD-ROM | disk | FTP | other *** search
/ Cream of the Crop 1 / Cream of the Crop 1.iso / COMM / RZSZ1291.ARJ / SZ.DOC < prev    next >
Text File  |  1991-10-30  |  17KB  |  397 lines
  1.  
  2.  
  3.  
  4.      SSSSZZZZ((((1111))))        OOOOmmmmeeeennnn TTTTeeeecccchhhhnnnnoooollllooooggggyyyy    IIIINNNNCCCC ((((OOOOMMMMEEEENNNN))))         SSSSZZZZ((((1111))))
  5.  
  6.  
  7.  
  8.      NNNNAAAAMMMMEEEE
  9.       sx, sb, sz - Send Files with ZMODEM, YMODEM, or XMODEM
  10.       zcommand, zcommandi -    Send COmmands with ZMODEM
  11.  
  12.      SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  13.       sz [-++++aaaabbbbddddeeeeffffkkkkLLLLllllNNNNnnnnooooppppTTTTttttuuuuvvvvyyyyYYYYZZZZ] _f_i_l_e ...
  14.       sb [-ddddffffkkkkttttuuuuvvvv] _f_i_l_e ...
  15.       sx [-kkkkttttuuuuvvvv] _f_i_l_e
  16.       zcommand [-oooottttvvvv] CCCCOOOOMMMMMMMMAAAANNNNDDDD
  17.       zcommandi [-oooottttvvvv] CCCCOOOOMMMMMMMMAAAANNNNDDDD
  18.       sz -TT
  19.  
  20.      DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  21.       SSSSzzzz (send ZMODEM) uses    the ZMODEM, YMODEM or XMODEM error
  22.       correcting protocol to send one or more files    over a dial-in
  23.       serial port to a variety of programs running under PC-DOS,
  24.       CP/M,    Unix, VMS, and other operating systems.
  25.  
  26.       This is a copyrighted    shareware program.  Commercial use of
  27.       this program is subject to licensing conditions detailed in
  28.       the rz.c source code.     "Commercial Use" includes use of this
  29.       program to send files    to commercial and/or shareware
  30.       programs not published by Omen Technology INC.
  31.  
  32.  
  33.       This program is not designed to be called from _c_u(_1) _t_i_p(_1),
  34.       or other communications programs.  Unix flavors of Omen
  35.       Technology's Professional-YAM    communications software    are
  36.       available for    dial-out applications.    Unix Professional-YAM
  37.       supports dial-out applications with telephone    directory, a
  38.       powerful script language with    learn function,    high quality
  39.       multiple protocol support, and UUCP port arbitration.
  40.  
  41.  
  42.       SSSSzzzz sends one or more files with ZMODEM protocol.
  43.  
  44.       ZMODEM greatly simplifies file transfers compared to XMODEM.
  45.       In addition to a friendly user interface, ZMODEM provides
  46.       Personal Computer and    other users an efficient, accurate,
  47.       and robust file transfer method.
  48.  
  49.       ZMODEM provides complete EEEENNNNDDDD----TTTTOOOO----EEEENNNNDDDD data integrity between
  50.       application programs.     ZMODEM's 32 bit CRC catches errors
  51.       that sneak into even the most    advanced networks.
  52.  
  53.       Advanced file    management features include AutoDownload
  54.       (Automatic file Download initiated without user
  55.       intervention), Display of individual and total file lengths
  56.       and transmission time    estimates, Crash Recovery, selective
  57.       file transfers, and preservation of exact file date and
  58.       length.
  59.  
  60.  
  61.  
  62.  
  63.      Page 1                        (printed 10/30/91)
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70.      SSSSZZZZ((((1111))))        OOOOmmmmeeeennnn TTTTeeeecccchhhhnnnnoooollllooooggggyyyy    IIIINNNNCCCC ((((OOOOMMMMEEEENNNN))))         SSSSZZZZ((((1111))))
  71.  
  72.  
  73.  
  74.       The ----yyyy option    instructs the receiver to open the file    for
  75.       writing unconditionally.  The    ----aaaa option causes the receiver
  76.       to convert Unix newlines to PC-DOS carriage returns and
  77.       linefeeds.
  78.  
  79.  
  80.       SSSSbbbb sends one or more files with YMODEM or ZMODEM protocol.
  81.       The initial ZMODEM initialization is not sent.  When
  82.       requested by the receiver, ssssbbbb    supports YYYYMMMMOOOODDDDEEEEMMMM----gggg with
  83.       "cbreak" tty mode, XON/XOFF flow control, and    interrupt
  84.       character set    to CAN (^X).  YYYYMMMMOOOODDDDEEEEMMMM----gggg (Professional-YAM gggg
  85.       option) increases YMODEM throughput over error free channels
  86.       (direct connection, X.PC, etc.) by disabling error recovery.
  87.  
  88.       On Unix systems, additional information about    the file is
  89.       transmitted.    If the receiving program uses this
  90.       information, the transmitted file length controls the    exact
  91.       number of bytes written to the output    dataset, and the
  92.       modify time and file mode are    set accordingly.
  93.  
  94.  
  95.       SSSSxxxx sends a single _f_i_l_e with XXXXMMMMOOOODDDDEEEEMMMM or    XXXXMMMMOOOODDDDEEEEMMMM----1111kkkk protocol
  96.       (sometimes incorrectly called    "ymodem").  The    user must
  97.       supply the file name to both sending and receiving programs.
  98.  
  99.       Iff sssszzzz is invoked with $SHELL    set and    iff that variable
  100.       contains the string _r_s_h or _r_k_s_h (restricted shell), sssszzzz
  101.       operates in restricted mode.    Restricted mode    restricts
  102.       pathnames to the current directory and PUBDIR    (usually
  103.       /usr/spool/uucppublic) and/or    subdirectories thereof.
  104.  
  105.  
  106.       The fourth form sends    a single COMMAND to a ZMODEM receiver
  107.       for execution.  ZZZZccccoooommmmmmmmaaaannnndddd exits with the COMMAND return
  108.       value.  If COMMAND includes spaces or    characters special to
  109.       the shell, it    must be    quoted.
  110.  
  111.  
  112.       The fifth form sends a single    COMMAND    to a ZMODEM receiver
  113.       for execution.  ZZZZccccoooommmmmmmmaaaannnnddddiiii exits as soon as the receiver has
  114.       correctly received the command, before it is executed.
  115.  
  116.  
  117.       The sixth form (sz -TT) attempts to output all 256 code
  118.       combinations to the terminal.     In you    are having difficulty
  119.       sending files, this command lets you see which character
  120.       codes    are being eaten    by the operating system.
  121.  
  122.  
  123.  
  124.       The meanings of the available    options    are:
  125.  
  126.  
  127.  
  128.  
  129.      Page 2                        (printed 10/30/91)
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136.      SSSSZZZZ((((1111))))        OOOOmmmmeeeennnn TTTTeeeecccchhhhnnnnoooollllooooggggyyyy    IIIINNNNCCCC ((((OOOOMMMMEEEENNNN))))         SSSSZZZZ((((1111))))
  137.  
  138.  
  139.  
  140.       ++++    Instruct    the receiver to    append transmitted data    to an
  141.            existing    file (ZMODEM only).
  142.       aaaa    Instruct    the ZMODEM receiver to convert text file
  143.            format as appropriate for the receiving system.    Valid
  144.            only for    ZMODEM.
  145.       bbbb    (ZMODEM)    Binary override: transfer file without any
  146.            translation.
  147.       cccc    Instruct    the receiver to    change the pathname if the
  148.            destination file    exists.
  149.       dddd    Change all instances of "." to "/" in the transmitted
  150.            pathname.  Thus,    C.omenB0000 (which is unacceptable to
  151.            MSDOS or    CP/M) is transmitted as    C/omenB0000.  If the
  152.            resultant filename has more than    8 characters in    the
  153.            stem, a "." is inserted to allow    a total    of eleven.
  154.       eeee    Escape all control characters; normally only XON, XOFF,
  155.            DLE, CR-@-CR, and Ctrl-X    are escaped.
  156.       ffff    Send Full pathname.  Normally directory prefixes    are
  157.            stripped    from the transmitted filename.
  158.       kkkk    (XMODEM/YMODEM) Send files using    1024 byte blocks
  159.            rather than the default 128 byte    blocks.     1024 byte
  160.            packets speed file transfers at high bit    rates.
  161.            (ZMODEM streams the data    for the    best possible
  162.            throughput.)
  163.       LLLL NNNN  Use ZMODEM sub-packets of length    N.  A larger N (32 <=
  164.            N <= 1024) gives    slightly higher    throughput, a smaller
  165.            N speeds    error recovery.     The default is    128 below 300
  166.            baud, 256 above 300 baud, or 1024 above 2400 baud.
  167.       llll NNNN  Wait for    the receiver to    acknowledge correct data every
  168.            NNNN (32 <=    N <= 1024) characters.    This may be used to
  169.            avoid network overrun when XOFF flow control is
  170.            lacking.
  171.       nnnn    (ZMODEM)    Send each file if destination file does    not
  172.            exist.  Overwrite destination file if source file is
  173.            newer than the destination file.
  174.       NNNN    (ZMODEM)    Send each file if destination file does    not
  175.            exist.  Overwrite destination file if source file is
  176.            newer or    longer than the    destination file.
  177.       oooo    (ZMODEM)    Disable    automatic selection of 32 bit CRC.
  178.       pppp    (ZMODEM)    Protect    existing destination files by skipping
  179.            transfer    if the destination file    exists.
  180.       rrrr    (ZMODEM)    Resume interrupted file    transfer.  If the
  181.            source file is longer than the destination file,    the
  182.            transfer    commences at the offset    in the source file
  183.            that equals the length of the destination file.
  184.       rrrrrrrr   As above, but compares the files    (the portion common to
  185.            sender and reciever) before resuming the    transfer.
  186.       tttt ttttiiiimmmm
  187.            Change timeout to _t_i_m tenths of seconds.
  188.       uuuu    Unlink the file after successful    transmission.
  189.       wwww NNNN  Limit the transmit window size to N bytes (ZMODEM).
  190.       vvvv    Verbose causes a    list of    file names to be appended to
  191.            /tmp/szlog .  More v's generate more output.
  192.  
  193.  
  194.  
  195.      Page 3                        (printed 10/30/91)
  196.  
  197.  
  198.  
  199.  
  200.  
  201.  
  202.      SSSSZZZZ((((1111))))        OOOOmmmmeeeennnn TTTTeeeecccchhhhnnnnoooollllooooggggyyyy    IIIINNNNCCCC ((((OOOOMMMMEEEENNNN))))         SSSSZZZZ((((1111))))
  203.  
  204.  
  205.  
  206.       yyyy    Instruct    a ZMODEM receiving program to overwrite    any
  207.            existing    file with the same name.
  208.       YYYY    Instruct    a ZMODEM receiving program to overwrite    any
  209.            existing    file with the same name, and to    skip any
  210.            source files that do have a file    with the same pathname
  211.            on the destination system.
  212.       ZZZZ    Use ZMODEM file compression to speed file transfer.
  213.  
  214.      DDDDIIIIAAAAGGGGNNNNOOOOSSSSTTTTIIIICCCCSSSS
  215.       Exit status is as follows: 0 for successful transfers.  1 if
  216.       unrecoverable    errors are detected.  2    if syntax errors or
  217.       file access problems are detected.  3    if the program was
  218.       terminated by    a caught interrupt.
  219.  
  220.      EEEEXXXXAAAAMMMMPPPPLLLLEEEESSSS
  221.       ZZZZMMMMOOOODDDDEEEEMMMM FFFFiiiilllleeee TTTTrrrraaaannnnssssffffeeeerrrr (Unix to    DSZ/ZCOMM/Professional-YAM)
  222.       %%%% sssszzzz ----aaaa ****....cccc
  223.       This single command transfers    all .c files in    the current
  224.       Unix directory with conversion (----aaaa) to end of    line
  225.       conventions appropriate to the receiving environment.     With
  226.       ZMODEM AutoDownload enabled, Professional-YAM     and ZCOMM
  227.       will automatically recieve the files after performing    a
  228.       security check.
  229.  
  230.       %%%% sssszzzz ----YYYYaaaannnn ****....cccc    ****....hhhh
  231.       Send only the    .c and .h files    that exist on both systems,
  232.       and are newer    on the sending system than the corresponding
  233.       version on the receiving system, converting Unix to DOS text
  234.       format.
  235.  
  236.       ZZZZMMMMOOOODDDDEEEEMMMM CCCCoooommmmmmmmaaaannnndddd DDDDoooowwwwnnnnllllooooaaaadddd (Unix    to Professional-YAM)
  237.        cpszall:all
  238.           zcommand "c:;cd /yam/dist"
  239.           sz -ya $(YD)/*.me
  240.           sz -yb y*.exe
  241.           zcommand "cd /yam"
  242.           zcommandi    "!insms"
  243.       This Makefile    fragment uses zzzzccccoooommmmmmmmaaaannnndddd to issue    commands to
  244.       Professional-YAM to change current disk and directory.
  245.       Next,    sssszzzz transfers the ._m_e files from    the $YD    directory,
  246.       commanding the receiver to overwrite the old files and to
  247.       convert from Unix end    of line    conventions to PC-DOS
  248.       conventions.    The third line transfers some ._e_x_e files.  The
  249.       fourth and fifth lines command Pro-YAM to change directory
  250.       and execute a    PC-DOS batch file _i_n_s_m_s    . Since    the batch file
  251.       takes    considerable time, the zzzzccccoooommmmmmmmaaaannnnddddiiii form is used to allow
  252.       the program to exit immediately.
  253.  
  254.       XXXXMMMMOOOODDDDEEEEMMMM FFFFiiiilllleeee TTTTrrrraaaannnnssssffffeeeerrrr (Unix to    Crosstalk)
  255.       % ssssxxxx ffffoooooooo....cccc
  256.       EEEESSSSCCCC
  257.       rrrrxxxx ffffoooooooo....cccc
  258.  
  259.  
  260.  
  261.      Page 4                        (printed 10/30/91)
  262.  
  263.  
  264.  
  265.  
  266.  
  267.  
  268.      SSSSZZZZ((((1111))))        OOOOmmmmeeeennnn TTTTeeeecccchhhhnnnnoooollllooooggggyyyy    IIIINNNNCCCC ((((OOOOMMMMEEEENNNN))))         SSSSZZZZ((((1111))))
  269.  
  270.  
  271.  
  272.       The above three commands transfer a single file from Unix to
  273.       a PC and Crosstalk.  This combination    is much    slower and
  274.       less reliable    than ZMODEM.
  275.  
  276.      EEEERRRRRRRROOOORRRR MMMMEEEESSSSSSSSAAAAGGGGEEEESSSS
  277.       "Caught signal 99" indicates the program was not properly
  278.       compiled, refer to "bibi(99)"    in rbsb.c for details.
  279.  
  280.      SSSSEEEEEEEE AAAALLLLSSSSOOOO
  281.       rz(omen), ZMODEM.DOC,    YMODEM.DOC, Professional-YAM,
  282.       crc(omen), sq(omen), todos(omen), tocpm(omen), tomac(omen),
  283.       yam(omen)
  284.  
  285.       Compile time options required    for various operating systems
  286.       are described    in the source file.
  287.  
  288.      FFFFIIIILLLLEEEESSSS
  289.       32 bit CRC code courtesy Gary    S. Brown.
  290.  
  291.       sz.c,    crctab.c, rbsb.c, zm.c,    zmr.c, zmodem.h    Unix source
  292.       files
  293.  
  294.       /tmp/szlog stores debugging output (sz -vv)
  295.  
  296.      TTTTEEEESSSSTTTTIIIINNNNGGGG FFFFEEEEAAAATTTTUUUURRRREEEE
  297.       The command "sz -T file" exercises the AAAAttttttttnnnn sequence error
  298.       recovery by commanding errors    with unterminated packets.
  299.       The receiving    program    should complain    five times about
  300.       binary data packets being too    long.  Each time sssszzzz is
  301.       interrupted, it should send a    ZDATA header followed by
  302.       another defective packet.  If    the receiver does not detect
  303.       five long data packets, the AAAAttttttttnnnn sequence is not
  304.       interrupting the sender, and the MMMMyyyyaaaattttttttnnnn string in sssszzzz....cccc must
  305.       be modified.
  306.  
  307.       After    5 packets, sssszzzz stops the    "transfer" and prints the
  308.       total    number of characters "sent" (Tcount).  The difference
  309.       between Tcount and 5120 represents the number    of characters
  310.       stored in various buffers when the Attn sequence is
  311.       generated.
  312.  
  313.      NNNNOOOOTTTTEEEESSSS
  314.       When using TrailBlazer or other buffered modems at high
  315.       speed, particular attention must be paid to flow control.
  316.       The modem and    Unix must agree    on the flow control method.
  317.       Sz on    USG (SYS III/V)    systems    uses XON/XOFF flow control.
  318.       If flow control cannot be properly set up, Try a "-w 2048"
  319.       option to enforce protocol level flow    control.  Experiment
  320.       with different window    sizes for best results.
  321.  
  322.       Telebit modems must not be set to "spoof" UUCP, XMODEM, or
  323.       KERMIT.  Setting one of these    spoofing modes interferes with
  324.  
  325.  
  326.  
  327.      Page 5                        (printed 10/30/91)
  328.  
  329.  
  330.  
  331.  
  332.  
  333.  
  334.      SSSSZZZZ((((1111))))        OOOOmmmmeeeennnn TTTTeeeecccchhhhnnnnoooollllooooggggyyyy    IIIINNNNCCCC ((((OOOOMMMMEEEENNNN))))         SSSSZZZZ((((1111))))
  335.  
  336.  
  337.  
  338.       other    protoocls.
  339.  
  340.       If a program that does not properly implement    the specified
  341.       file transfer    protocol causes    _s_b to "hang" the port after a
  342.       failed transfer, either wait for _s_b to time out or keyboard
  343.       a dozen Ctrl-X characters.  Every reported instance of this
  344.       problem has been corrected by    using ZCOMM, Pro-YAM, DSZ, or
  345.       other    program    with a correct implementation of the specified
  346.       protocol.
  347.  
  348.       Many programs    claiming to support YMODEM only    support    XMODEM
  349.       with 1k blocks, and they often don't get that    quite right.
  350.       XMODEM transfers add up to 127 garbage bytes per file.
  351.       XMODEM-1k and    YMODEM-1k transfers use    128 byte blocks    to
  352.       avoid    extra padding.
  353.  
  354.       YMODEM programs use the file length transmitted at the
  355.       beginning of the transfer to prune the file to the correct
  356.       length; this may cause problems with source files that grow
  357.       during the course of the transfer.  This problem does    not
  358.       pertain to ZMODEM transfers, which preserve the exact    file
  359.       length unconditionally.
  360.  
  361.       Most ZMODEM options are merely passed    to the receiving
  362.       program; some    programs do not    implement all of these
  363.       options.
  364.  
  365.       Circular buffering and a ZMODEM sliding window should    be
  366.       used when input is from pipes    instead    of acknowledging
  367.       frames each 1024 bytes.  If no files can be opened, sssszzzz sends
  368.       a ZMODEM command to echo a suitable complaint; perhaps it
  369.       should check for the presence    of at least one    accessible
  370.       file before getting hot and bothered.
  371.  
  372.      BBBBUUUUGGGGSSSS
  373.       On at    least one BSD system, sz would abend it    got within a
  374.       few kilobytes    of the end of file.  Using the "-w 8192" flag
  375.       fixed    the problem.  The real cause is    unknown, perhaps a bug
  376.       in the kernel    TTY output routines.
  377.  
  378.       The test mode    leaves a zero length file on the receiving
  379.       system.
  380.  
  381.  
  382.  
  383.  
  384.  
  385.  
  386.  
  387.  
  388.  
  389.  
  390.  
  391.  
  392.  
  393.      Page 6                        (printed 10/30/91)
  394.  
  395.  
  396.  
  397.